/*
 * Copyright (c) 2014-2023 Stream.io Inc. All rights reserved.
 *
 * Licensed under the Stream License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.getstream.chat.android.extensions

/**
 * Limits the integer value to the given range.
 *
 * @param min The minimum value.
 * @param max The maximum value.
 */
@Deprecated(
    message = "This function is deprecated and will be removed in the future. " +
        "Use `kotlin.ranges.coerceIn` instead.",
    replaceWith = ReplaceWith("this.coerceIn(min, max)"),
)
public fun Int.limitTo(min: Int, max: Int): Int {
    return when {
        this < min -> min
        this > max -> max
        else -> this
    }
}
